<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_stream::async_connect (5 of 5 overloads)</title>
<link rel="stylesheet" href="../../../../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../../../index.html" title="Chapter 1. Boost.Beast">
<link rel="up" href="../async_connect.html" title="basic_stream::async_connect">
<link rel="prev" href="overload4.html" title="basic_stream::async_connect (4 of 5 overloads)">
<link rel="next" href="../read_some.html" title="basic_stream::read_some">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../../boost.png"></td>
<td align="center"><a href="../../../../../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overload4.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../async_connect.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../read_some.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h6 class="title">
<a name="beast.ref.boost__beast__basic_stream.async_connect.overload5"></a><a class="link" href="overload5.html" title="basic_stream::async_connect (5 of 5 overloads)">basic_stream::async_connect
          (5 of 5 overloads)</a>
</h6></div></div></div>
<p>
            Establishes a connection by trying each endpoint in a sequence asynchronously.
          </p>
<h7><a name="beast.ref.boost__beast__basic_stream.async_connect.overload5.h0"></a>
            <span class="phrase"><a name="beast.ref.boost__beast__basic_stream.async_connect.overload5.synopsis"></a></span><a class="link" href="overload5.html#beast.ref.boost__beast__basic_stream.async_connect.overload5.synopsis">Synopsis</a>
          </h7><pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
    <span class="keyword">class</span> <span class="identifier">Iterator</span><span class="special">,</span>
    <span class="keyword">class</span> <a href="../../../../../../../../doc/html/boost_asio/reference/ConnectCondition.html" target="_top"><span class="emphasis"><em>ConnectCondition</em></span></a><span class="special">,</span>
    <span class="keyword">class</span> <a href="../../../../../../../../doc/html/boost_asio/reference/IteratorConnectHandler.html" target="_top"><span class="emphasis"><em>IteratorConnectHandler</em></span></a> <span class="special">=</span> <span class="identifier">net</span><span class="special">::</span><span class="identifier">default_completion_token_t</span><span class="special">&lt;</span><a class="link" href="../executor_type.html" title="basic_stream::executor_type">executor_type</a><span class="special">&gt;&gt;</span>
<a href="../../../../../../../../doc/html/boost_asio/reference/asynchronous_operations.html#boost_asio.reference.asynchronous_operations.automatic_deduction_of_initiating_function_return_type" target="_top"><span class="emphasis"><em>DEDUCED</em></span></a>
<span class="identifier">async_connect</span><span class="special">(</span>
    <span class="identifier">Iterator</span> <span class="identifier">begin</span><span class="special">,</span>
    <span class="identifier">Iterator</span> <span class="identifier">end</span><span class="special">,</span>
    <span class="identifier">ConnectCondition</span> <span class="identifier">connect_condition</span><span class="special">,</span>
    <span class="identifier">IteratorConnectHandler</span><span class="special">&amp;&amp;</span> <span class="identifier">handler</span> <span class="special">=</span> <span class="identifier">net</span><span class="special">::</span><span class="identifier">default_completion_token_t</span><span class="special">&lt;</span> <a class="link" href="../executor_type.html" title="basic_stream::executor_type">executor_type</a> <span class="special">&gt;{});</span>
</pre>
<h7><a name="beast.ref.boost__beast__basic_stream.async_connect.overload5.h1"></a>
            <span class="phrase"><a name="beast.ref.boost__beast__basic_stream.async_connect.overload5.description"></a></span><a class="link" href="overload5.html#beast.ref.boost__beast__basic_stream.async_connect.overload5.description">Description</a>
          </h7><p>
            This function attempts to connect the stream to one of a sequence of
            endpoints by trying each endpoint until a connection is successfully
            established. The algorithm, known as a <span class="emphasis"><em>composed asynchronous
            operation</em></span>, is implemented in terms of calls to the underlying
            socket's <code class="computeroutput"><span class="identifier">async_connect</span></code>
            function. If the timeout timer expires while the operation is outstanding,
            the current connection attempt will be canceled and the completion handler
            will be invoked with the error <a class="link" href="../../boost__beast__error.html" title="error"><code class="computeroutput"><span class="identifier">error</span><span class="special">::</span><span class="identifier">timeout</span></code></a>.
          </p>
<h7><a name="beast.ref.boost__beast__basic_stream.async_connect.overload5.h2"></a>
            <span class="phrase"><a name="beast.ref.boost__beast__basic_stream.async_connect.overload5.parameters"></a></span><a class="link" href="overload5.html#beast.ref.boost__beast__basic_stream.async_connect.overload5.parameters">Parameters</a>
          </h7><div class="informaltable"><table class="table">
<colgroup>
<col>
<col>
</colgroup>
<thead><tr>
<th>
                    <p>
                      Name
                    </p>
                  </th>
<th>
                    <p>
                      Description
                    </p>
                  </th>
</tr></thead>
<tbody>
<tr>
<td>
                    <p>
                      <code class="computeroutput"><span class="identifier">begin</span></code>
                    </p>
                  </td>
<td>
                    <p>
                      An iterator pointing to the start of a sequence of endpoints.
                    </p>
                  </td>
</tr>
<tr>
<td>
                    <p>
                      <code class="computeroutput"><span class="identifier">end</span></code>
                    </p>
                  </td>
<td>
                    <p>
                      An iterator pointing to the end of a sequence of endpoints.
                    </p>
                  </td>
</tr>
<tr>
<td>
                    <p>
                      <code class="computeroutput"><span class="identifier">connect_condition</span></code>
                    </p>
                  </td>
<td>
                    <p>
                      A function object that is called prior to each connection attempt.
                      The signature of the function object must be:
                    </p>
<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="keyword">bool</span> <span class="identifier">connect_condition</span><span class="special">(</span>
    <span class="identifier">error_code</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">ec</span><span class="special">,</span>
    <span class="keyword">typename</span> <span class="identifier">Protocol</span><span class="special">::</span><span class="identifier">endpoint</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">next</span><span class="special">);</span>
</pre>
                  </td>
</tr>
<tr>
<td>
                    <p>
                      <code class="computeroutput"><span class="identifier">handler</span></code>
                    </p>
                  </td>
<td>
                    <p>
                      The completion handler to invoke when the operation completes.
                      The implementation takes ownership of the handler by performing
                      a decay-copy. The equivalent function signature of the handler
                      must be:
                    </p>
<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="keyword">void</span> <span class="identifier">handler</span><span class="special">(</span>
    <span class="comment">// Result of operation. if the sequence is empty, set to</span>
    <span class="comment">// net::error::not_found. Otherwise, contains the</span>
    <span class="comment">// error from the last connection attempt.</span>
    <span class="identifier">error_code</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">error</span><span class="special">,</span>

    <span class="comment">// On success, an iterator denoting the successfully</span>
    <span class="comment">// connected endpoint. Otherwise, the end iterator.</span>
    <span class="identifier">Iterator</span> <span class="identifier">iterator</span>
<span class="special">);</span>
</pre>
                    <p>
                      Regardless of whether the asynchronous operation completes
                      immediately or not, the handler will not be invoked from within
                      this function. Invocation of the handler will be performed
                      in a manner equivalent to using <code class="computeroutput"><span class="identifier">net</span><span class="special">::</span><span class="identifier">post</span></code>.
                    </p>
                  </td>
</tr>
</tbody>
</table></div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie
      Falco<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overload4.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../async_connect.html"><img src="../../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../index.html"><img src="../../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../read_some.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
